Improve docs for GtkStateType. (Fixes #55751, among other things.)

Tue Jun  5 10:54:48 2001  Owen Taylor  <otaylor@redhat.com>

	* gtk/tmpl/gtkenums.sgml: Improve docs for GtkStateType.
	(Fixes #55751, among other things.)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 7c0af55c48e177705c6019442a8218021a5ad42a..8d4e86042cf286baddf8195129756535ab67be53 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+Tue Jun  5 10:54:48 2001  Owen Taylor  <otaylor@redhat.com>
+
+       * gtk/tmpl/gtkenums.sgml: Improve docs for GtkStateType.
+       (Fixes #55751, among other things.)
+
 Mon Jun  4 15:08:21 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gtk/gtk-overrides.txt: Remove GtkArgSetFunc, GtkArgGetFunc.

diff --git a/docs/reference/gtk/tmpl/gtkenums.sgml b/docs/reference/gtk/tmpl/gtkenums.sgml
index 7fbd1e25d183493a76c1a129408fddb7f6e7f34f..0b086b36c044fed442b353f13c597d4d5025c5e4 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkenums.sgml
+++ b/docs/reference/gtk/tmpl/gtkenums.sgml
@@ -288,15 +288,19 @@ does
 
 <!-- ##### ENUM GtkStateType ##### -->
 <para>
-This type indicates the current state of a widget.
-</para>
-
-@GTK_STATE_NORMAL: The state during normal operation.
-@GTK_STATE_ACTIVE: The widget is currently active, such as a
-@GTK_STATE_PRELIGHT: The mouse pointer is over the widget.
-@GTK_STATE_SELECTED: 
-@GTK_STATE_INSENSITIVE: The state of the widget can not be altered by the
-user. Its appearance will usually indicate this.
+This type indicates the current state of a widget; the state determines how
+the widget is drawn. The #GtkStateType enumeration is also used to
+identify different colors in a #GtkStyle for drawing, so states can be
+used for subparts of a widget as well as entire widgets.
+</para>
+
+@GTK_STATE_NORMAL: State during normal operation.
+@GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
+@GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
+the widget and the widget will respond to mouse clicks.
+@GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
+@GTK_STATE_INSENSITIVE: State indicating that the widget is
+unresponsive to user actions.
 
 <!-- ##### ENUM GtkSubmenuDirection ##### -->
 <para>